logo
API docs by Redocly

Journal Service API (2.10)

Download OpenAPI specification:Download

Journal Service Concepts

Abstract

The primary purpose of the Journal service is to provide the ability to create and modify journal items such as journals, follow-ups, and trouble tickets.

Operations

Create Journal Item

Provides the ability to create journal items such as journals, follow-ups, and trouble tickets.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action=https://webservices.idibilling.com/journalservice1/CreateJournalItem
Request Body schema: application/soap+xml
required
object (CreateJournalItem)

Provides the ability to create journal items such as journals, follow-ups, and trouble tickets.

Responses

Modify Extended Information

Provides the ability to modify the extended information that is associated with various types of objects. [Rev 1.01]

header Parameters
Content-Type
required
string
Example: application/soap+xml; action=https://webservices.idibilling.com/journalservice1/ModifyExtendedInformation
Request Body schema: application/soap+xml
required
object (ModifyExtendedInformation)

Responses

Modify Journal Item

Provides the ability to modify journal items such as journals, follow-ups, and trouble tickets.

header Parameters
Content-Type
required
string
Example: application/soap+xml; action=https://webservices.idibilling.com/journalservice1/ModifyJournalItem
Request Body schema: application/soap+xml
required
object (ModifyJournalItem)

Provides the ability to modify journal items such as journals, follow-ups, and trouble tickets.

Responses

Core Data Service

Abstract

The purpose of the CoreDataService endpoint is to supply a set of search capabilities that can be used for data retrieval.

Authorization

In order to retrieve information from a data service, proper authorization credentials must be included in a header of the request. To do this, first find the Simple Web Token claim (ClaimType = "http://idibilling.com/SWT") within the Request Security Token returned to you from the 'Issue' call to the Security Token Service. Once found, the Simple Web Token must be submitted with each request in an "Authorization" header with a value in exactly the following format: WRAP access_token="<Simple Web Token>" where <Simple Web Token> between double quotes is replaced with the SWT claim string value between double quotes.

Available Ticket Location

List of all locations in the system that can be assigned to a ticket. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": "My AccountNumber",
  • "BillingStatus": "My Billing Status",
  • "BillingStatusID": 47,
  • "City": "City Of Oz",
  • "ContactID": 357,
  • "ContactType": "ContactType Name",
  • "ContactTypeID": 26,
  • "Country": "Mozambique",
  • "CustomerID": 25,
  • "CustomerName": "Yuriy",
  • "ServiceAddressID": 82468,
  • "ServiceCatalog": "SericeCatalog Description",
  • "ServiceCatalogID": 47,
  • "ServiceID": -1,
  • "ServiceNumber": "My ServiceNumber",
  • "State": "Ohio",
  • "Street1": "445 Mount Eden Road, Mount Eden, Auckland",
  • "Street2": "252 Cisco Avenue, Warchester, 64623",
  • "Street3": "3634 Main Street, NY, 35252",
  • "ZipCode": 52526
}

Corporate Account Ticket Journal Item

A list of all tickets in the system that are associated with customers in a corporate account hierarchy. [Rev 1.08]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": "My AccountNumber",
  • "ActionDate": "2008-10-27T20:03:36.443Z",
  • "AssignedUser": "Username",
  • "Carrier": "Carrier Description",
  • "CarrierID": 376,
  • "Category": "Category Description",
  • "CategoryID": 537,
  • "CloseDate": "2008-10-27T20:03:36.443Z",
  • "CloseUser": "Username",
  • "CommitDate": "2008-10-27T20:03:36.443Z",
  • "ContactFullName": "John Abernathy Smith",
  • "ContactID": 537,
  • "CreateDate": "2008-10-27T20:03:36.443Z",
  • "CreateUser": "Username",
  • "CurrentOnHoldSeconds": 47,
  • "CustomerID": 467,
  • "CustomerName": "Customer Name",
  • "Description": "My Descriptive Text",
  • "EmailAddress": "auser@mail.com",
  • "Facilitator": "Username",
  • "HoldDate": "2008-10-27T20:03:36.443Z",
  • "IsInternal": false,
  • "IsRetained": true,
  • "JournalItemID": 457,
  • "JournalItemStatus": 573,
  • "JournalItemStatusID": 57,
  • "JournalItemType": "My Journal Item Type",
  • "JournalItemTypeID": 356,
  • "ObjectDescription": "My ObjectDescription",
  • "ObjectID": 3567,
  • "ObjectType": "JournalItem",
  • "ObjectTypeDisplay": "My ObjectTypeDisplay",
  • "OnHold": true,
  • "ReferenceNumber": 367357375,
  • "ResolutionNote": "My Resolution Note",
  • "RootCustomerID": 357,
  • "SubCategory1": "My SubCategory1 Description",
  • "SubCategory1ID": 463,
  • "SubCategory2": "My SubCategory2 Description",
  • "SubCategory2ID": 346,
  • "TicketClass": "TicketClass Description",
  • "TicketClassID": 3,
  • "TicketHoldReason": "My Ticket Hold Reason",
  • "TicketHoldReasonID": 467,
  • "TicketImpact": "Ticket Impact Description",
  • "TicketImpactID": 346,
  • "TicketPriority": "Ticket Priority Description",
  • "TicketPriorityID": 367,
  • "TicketResolutionType": "Ticket Resolution Type Description",
  • "TicketResolutionTypeID": 457,
  • "TicketState": "Ticket State Description",
  • "TicketStateID": 2,
  • "TicketUrgency": "Ticket Urgency Description",
  • "TicketUrgencyID": 47,
  • "Title": "Ticket Title",
  • "TotalOnHoldSeconds": 60,
  • "TrackingNumber": 357375375,
  • "WebViewable": true,
  • "WorkflowEnvironment": "My WorkflowEnvironnment",
  • "WorkItemInstanceID": 456
}

Extended Information Item

A list of additional key/value properties associated with any objects of the types shown. [Rev 1.01]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Key": "My Extended Property Name",
  • "ObjectID": "My ObjectID",
  • "ObjectType": "JournalItem",
  • "Value": "My Value"
}

Journal Item

The base element for response as well as ModifyJournalItem request information that is common to all classes of journal items.

  • Note: This base element is valid and will be processed the same as a Journal.
  • Valid Objects: Journal, FollowUp, Ticket
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": "My Account Number",
  • "ActionDate": "2008-10-27T16:03:36.443Z",
  • "ActionDateWithOffset": "2008-10-27T20:03:36.443Z",
  • "AssignedUser": "Username",
  • "CloseDate": "2008-10-27T16:03:36.443Z",
  • "CloseDateWithOffset": "2008-10-27T20:03:36.443Z",
  • "CloseUser": "Username",
  • "CreateDate": "2008-10-27T16:03:36.443Z",
  • "CreateDateWithOffset": "2008-10-27T20:03:36.443Z",
  • "CreateUser": "Username",
  • "CustomerID": "My CustomerID",
  • "CustomerName": "My Customer Name",
  • "Description": "My Descriptive Journal Text",
  • "IsInternal": true,
  • "IsRetained": false,
  • "JournalItemClass": "JournalItemClass Name",
  • "JournalItemClassID": 2,
  • "JournalItemID": "",
  • "JournalItemStatus": "My JournalItemStatus",
  • "JournalItemStatusID": 325,
  • "JournalItemType": "My JournalItemType",
  • "JournalItemTypeID": "",
  • "ObjectID": 2335,
  • "ObjectType": "Other",
  • "ObjectTypeDisplay": "My ObjectTypeDisplay Name",
  • "WebViewable": true,
  • "WorkflowEnvironment": "My WorkflowEnvironment Name",
  • "WorkItemInstanceID": 56
}

Journal Item Child Journal Item Type Overview

An overview of all of the children for journals items in the system, including counts of total child items and internal-only child items. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ChildJournalItemClass": "ChildJournalItemClass",
  • "ChildJournalItemClassID": 356,
  • "ChildJournalItemType": "ChildJournalItemType Description",
  • "ChildJournalItemTypeID": 364,
  • "ChildJournalItemTypeInternalCount": 346,
  • "ChildJournalItemTypeTotalCount": 3457,
  • "JournalItemClass": "JournalItemclass Description",
  • "JournalItemClassID": 363,
  • "JournalItemID": 346
}

Journal Item History

A list of all historical actions that have been taken on journal items in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Action": "My Action Description",
  • "ActionDate": "2008-10-27T20:03:36.443Z",
  • "ActionID": 4,
  • "Description": "My Description",
  • "JournalItemID": 5684,
  • "JournalItemStatus": "My JournalItemStatus Description",
  • "JournalItemStatusID": 546,
  • "JournalItemType": "My JournalItemType Description",
  • "JournalItemTypeID": 568,
  • "UserID": "User"
}

Journal Item Status

Details of all journal item statuses configured in the system.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "My Description",
  • "JournalItemClass": "My JournalItemClass",
  • "JournalItemClassID": 1,
  • "JournalItemStatusID": 5353,
  • "KeyName": "My KeyName",
  • "TicketState": "My TicketState Description",
  • "TicketStateID": 463
}

Journal Item Type

Details of all journal item types configured in the system.

  • Note: The elements of type string (with the "WithOffset" ending) should be used instead of the corresponding elements of type string (without the "WithOffset" ending).
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AttributePropertyDisplay": "My AttributePropertyDisplay Name",
  • "AttributePropertyID": 4256,
  • "AutoAssignUserGroup": "My AutoAssignUserGroup Name",
  • "Description": "My Descriptive Text",
  • "EmailAlias": "auser@here.com",
  • "EmailLocalAddress": "auser",
  • "EndDate": "2008-10-27T16:03:36.443Z",
  • "EndDateWithOffset": "2008-10-27T20:03:36.443Z",
  • "EscalationGroup": "My EscalationGroup Group",
  • "EscalationHours": 2,
  • "JournalItemClass": "My JournalItemClass",
  • "JournalItemClassID": 2,
  • "JournalItemGroup": "My JournalItemGroup",
  • "JournalItemGroupID": 4,
  • "JournalItemTypeID": 3446,
  • "KeyName": "My KeyName",
  • "Severity": "My Severity",
  • "SeverityID": 35,
  • "StartDate": "2008-10-27T16:03:36.443Z",
  • "StartDateWithOffset": "2008-10-27T20:03:36.443Z",
  • "WebViewable": true
}

Journal Item Type Summary

A summary of total and active (if applicable) journal items for each journal item type. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "JournalItemActiveCount": 43,
  • "JournalItemClass": "My JournalItemClass",
  • "JournalItemClassID": 2,
  • "JournalItemCount": 25,
  • "JournalItemType": "JournalItemType Description",
  • "JournalItemTypeID": 44
}

Ticket Category

List of all ticket urgencies configured in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Name": "Ticket Category Name",
  • "TicketCategoryID": 252
}

Ticket Category Configuration

List of all ticket category configurations in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AutoAssignUserGroup": "AutoAssignUserGroup Name",
  • "Category": "Category Description",
  • "CategoryID": 236,
  • "DefaultTicketDescription": "My Default Description",
  • "DefaultTicketPriority": "Priority Description",
  • "DefaultTicketPriorityConfiguration": "My Priority Configuration",
  • "DefaultTicketPriorityConfigurationID": 2521,
  • "DefaultTicketPriorityID": 3463,
  • "DefaultTicketTitle": "My Default Title",
  • "JournalItemType": "My JournalItemType",
  • "JournalItemTypeID": 46,
  • "SubCategory1": "My SubCategory1 Description",
  • "SubCategory1ID": 24,
  • "SubCategory2": "SubCategory2 Description",
  • "SubCategory2ID": 242,
  • "TicketCategoryConfigurationID": 346
}

Ticket Class

Indicates the class of the Ticket. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Name": "TicketClass Name",
  • "TroubleClassID": 357
}

Ticket Hold Reason

List of all ticket hold reasons configured in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Description": "TicketHoldReason Description",
  • "TicketHoldReasonID": 25
}

Ticket Impact

List of all ticket impacts configured in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Name": "Ticket Impact Name",
  • "TicketImpactID": 25
}

Ticket Journal Item

Details of all tickets in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccounntNumber": "My Account Number",
  • "ActionDate": "2008-10-27T20:03:36.443Z",
  • "AssignedUser": "Username",
  • "Carrier": "Carrier Description",
  • "CarrierID": 47,
  • "Category": "Category Description",
  • "CategoryID": 467,
  • "CloseDate": "2008-10-27T20:03:36.443Z",
  • "CloseUser": "Username",
  • "CommitDate": "2008-10-27T20:03:36.443Z",
  • "ContactFullName": "John Abernathy Smith",
  • "ContactID": 347,
  • "CreateDate": "2008-10-27T20:03:36.443Z",
  • "CreateUser": "Username",
  • "CustomerID": 578,
  • "CustomerName": "Jane Smith",
  • "Description": "JournalItem Description",
  • "EmailAddress": "auser@mail.com",
  • "Equipment": "Equipment Name",
  • "EquipmentID": 484,
  • "EquipmentType": "EquipmentType Description",
  • "EquipmentTypeID": 4678,
  • "Facilitator": "Username",
  • "HoldDate": "2008-10-27T20:03:36.443Z",
  • "IsInternal": false,
  • "IsOnHold": true,
  • "IsRetained": true,
  • "JournalItemID": 367,
  • "JournalItemStatus": "My JournalItemStatus",
  • "JournalItemStatusID": 457,
  • "JournalItemType": "My JournalItemType",
  • "JournalItemTypeID": 574,
  • "ObjectID": 568,
  • "ObjectType": "Customer",
  • "ObjectTypeDisplay": "My ObjectTypeDisplay",
  • "ParentTicketJournalItemDescription": "ParentTicketJournalItemDescription Description",
  • "ParentTicketJournalItemID": 4687,
  • "ParentTicketJournalItemTitle": "ParentTicketJournalItemTitle Title",
  • "ReferenceNumber": 684,
  • "ResolutionNote": "My ResolutionNote Note",
  • "SubCategory1": "First Sub-Category Description",
  • "SubCategory1ID": 678,
  • "SubCategory2": "Second Sub-Category Description",
  • "SubCategory2ID": 464,
  • "TechnicianFullName": "John Abernathy Smith",
  • "TechnicianID": 468,
  • "TicketClass": "TicketClass Description",
  • "TicketClassID": 5,
  • "TicketHoldReason": "Ticket Hold Reason",
  • "TicketHoldReasonID": 68,
  • "TicketImpact": "TicketImpact Description",
  • "TicketImpactID": 857,
  • "TicketPriority": "TicketPriority Description",
  • "TicketPriorityID": 5568,
  • "TicketResolutionType": "TicketResolutionType Description",
  • "TicketResolutionTypeID": 579,
  • "TicketState": "TicketState Description",
  • "TicketStateID": 3,
  • "TicketUrgency": "TicketUrgency Description",
  • "TicketUrgencyID": 463,
  • "Title": "Ticket Title",
  • "TrackingNumber": 476,
  • "WebViewable": false,
  • "WorkflowEnvironment": "WorkflowEnvironment Name",
  • "WorkItemInstanceID": 578
}

Ticket Journal Item Summary

A list of all tickets in the system, including summary information. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": 37357,
  • "ActionDate": "2008-10-27T20:03:36.443Z",
  • "AssignedUser": "AssignedUsername",
  • "Carrier": "Carrier Description",
  • "CarrierID": 68,
  • "Category": "Category Description",
  • "CategoryID": 468,
  • "ChildTicketCount": 578,
  • "CloseDate": "2008-10-27T20:03:36.443Z",
  • "CloseUser": "Close Username",
  • "CommitDate": "2008-10-27T20:03:36.443Z",
  • "ContactFullName": "John Abernathy Smith",
  • "ContactID": 578,
  • "CreateDate": "2008-10-27T20:03:36.443Z",
  • "CreateUser": "Create Username",
  • "CurrentOnHoldSeconds": 60,
  • "CustomerID": 54,
  • "CustomerName": "Customer Name",
  • "Description": "My Descriptive Text",
  • "EmailAddress": "auser@mail.com",
  • "Equipment": "My Equipment Name",
  • "EquipmentID": 776,
  • "EquipmentType": "EquipmentType Description",
  • "EquipmentTypeID": 572,
  • "Facilitator": "Username",
  • "HoldDate": "2008-10-27T20:03:36.443Z",
  • "IsInternal": true,
  • "IsOnHold": true,
  • "IsRetained": false,
  • "JournalItemID": 574,
  • "JournalItemStatus": "My JournalItemStatus",
  • "JournalItemStatusID": 468,
  • "JournalItemType": "My JournalItemType",
  • "JournalItemTypeID": 578,
  • "ObjectDescription": "My ObjectDescription",
  • "ObjectID": 454,
  • "ObjectType": "BillingOrder",
  • "ObjectTypeDisplay": "My ObjectTypeDisplay",
  • "ParentTicketJournalItemDescription": "My Parent Ticket Journal Item Description",
  • "ParentTicketJournalItemID": 357,
  • "ParentTicketJournalItemTitle": "My Parent Ticket Journal Item Title",
  • "ReferenceNumber": 758574245,
  • "ResolutionNote": "My Resolution Note",
  • "SubCategory1": "My SubCategory1 Description",
  • "SubCategory1ID": 568,
  • "SubCategory2": "My SubCategory2 Description",
  • "SubCategory2ID": 36,
  • "TechnicianFullName": "John Abernathy Smith",
  • "TechnicianID": 346,
  • "TicketClass": "My TicketClass Description",
  • "TicketClassID": 4,
  • "TicketHoldReason": "My Ticket Hold Reason",
  • "TicketHoldReasonID": 74,
  • "TicketImpact": "My Ticket Impact Description",
  • "TicketImpactID": 486,
  • "TicketPriority": "Ticket Priority Description",
  • "TicketPriorityID": 468,
  • "TicketResolutionType": "My Ticket Resolution Type",
  • "TicketResolutionTypeID": 68,
  • "TicketState": "My Ticket State",
  • "TicketStateID": 3,
  • "TicketUrgency": "The TicketUrgency Description",
  • "TicketUrgencyID": 50,
  • "Title": "Ticket Title",
  • "TotalOnHoldSeconds": 462,
  • "TrackingNumber": "My Tracking Number",
  • "WebViewable": false,
  • "WorkflowEnvironment": "My WorkflowEnvironment",
  • "WorkItemInstanceID": 45
}

Ticket Location

A location specified by either a contact or service address that is an affected area for a ticket. [Rev 1.02]

  • Note: A service is specified for this location if either (1) ServiceID is non-NULL, or (2) both ServiceNumber and ServiceCatalogID are non-NULL. Only one of option (1) or (2) MAY be used to specify the service. Option (2) may only be used if the ticket does not reference a customer and it is not an 'Equipment' ticket. Otherwise, option (1) must be used to specify the service and it must be a service associated with the customer referenced by the ticket (unless the ticket is an 'Equipment' ticket).
  • Note: An address for this location is specified by either option (1) ContactID is non-NULL, or (2) ServiceAddressID is non-NULL. Exactly one of (1) or (2) MUST be true.
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AccountNumber": "My AccountNumber",
  • "City": "City Name",
  • "ContactID": 35,
  • "ContactType": "My Contact Type",
  • "ContactTypeID": 2425,
  • "Country": "Country Name",
  • "CustomerID": 47,
  • "CustomerName": "Carl Sagan",
  • "JournalItemID": 53,
  • "ServiceAddressID": 52,
  • "ServiceCatalog": "My ServiceCatalog Description",
  • "ServiceCatalogID": 36,
  • "ServiceID": 25,
  • "ServiceNumber": "My Service Number",
  • "State": "New Jersey",
  • "Street1": "445 Mount Eden Road, Mount Eden, Auckland",
  • "Street2": "3634 Main Street, New York City, NY, 35252",
  • "Street3": "252 Cisco Avenue, Warchester, 64623",
  • "TicketLocationID": 42,
  • "ZipCode": 64636
}

Ticket Priority

List of all ticket priorities configured in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "ColorHex": "#RRGGBB",
  • "ColorID": 6,
  • "CommitDateDefaultSeconds": 253,
  • "Name": "TicketPriority Name",
  • "TicketPriorityID": 4623
}

Ticket Priority Assigned User Overview

An overview of each ticket priority and assigned user, along with counts of total, active, and time-related properties. [Rev 1.02]

  • Note: The elements which count tickets based on their commit date are cumulative (e.g. TicketCommitWithin4HoursCount includes the tickets included in TicketCommitWithin1HourCount as well as any ticket whose commit date is between one and four hours in the future).
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedUser": "User",
  • "TicketActiveCount": 25,
  • "TicketCommitOverdueCount": 42,
  • "TicketCommitWithin1HourCount": 56,
  • "TicketCommitWithin24HoursCount": 4,
  • "TicketCommitWithin48HoursCount": 7,
  • "TicketCommitWithin4HoursCount": 6,
  • "TicketCommitWithin7DaysCount": 78,
  • "TicketCount": 104,
  • "TicketPriority": "TicketPriority Description",
  • "TicketPriorityID": 67
}

Ticket Priority Assigned User Ticket Class Overview

An overview of each ticket priority, assigned user, and ticket class, along with counts of total, active, and time-related properties. [Rev 1.06]

  • Note: The elements which count tickets based on their commit date are cumulative (e.g. TicketCommitWithin4HoursCount includes the tickets included in TicketCommitWithin1HourCount as well as any ticket whose commit date is between one and four hours in the future).
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "AssignedUser": "Username",
  • "TicketActiveCount": 457,
  • "TicketClass": "TicketClass Description",
  • "TicketClassID": 5,
  • "TicketCommitOverdueCount": 68,
  • "TicketCommitWithin1HourCount": 47,
  • "TicketCommitWithin24HoursCount": 36,
  • "TicketCommitWithin48HoursCount": 246,
  • "TicketCommitWithin4HoursCount": 47,
  • "TicketCommitWithin7DaysCount": 457,
  • "TicketCount": 46,
  • "TicketPriority": "My TicketPriority Description",
  • "TicketPriorityID": 56789
}

Ticket Priority Configuration

List of all ticket priority configurations in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "JournalItemType": "JournalItemType Description",
  • "JournalItemTypeID": 47,
  • "TicketImpact": "TicketImpact Description",
  • "TicketImpactID": 235,
  • "TicketPriority": "TicketPriority Description",
  • "TicketPriorityConfigurationID": 3235,
  • "TicketPriorityID": 235,
  • "TicketUrgency": "TicketUrgency Description",
  • "TicketUrgencyID": 47
}

Ticket Priority Journal Item Status Overview

An overview of each ticket priority and journal item status, along with counts of total, active, and time-related properties. [Rev 1.02]

  • Note: The elements which count tickets based on their commit date are cumulative (e.g. TicketCommitWithin4HoursCount includes the tickets included in TicketCommitWithin1HourCount as well as any ticket whose commit date is between one and four hours in the future).
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "JournalItemStatus": "JournalItemStatus Description",
  • "JournalItemStatusID": 23,
  • "TicketActiveCount": 4,
  • "TicketCommitOverdueCount": 57,
  • "TicketCommitWithin1HourCount": 890,
  • "TicketCommitWithin24HoursCount": 467,
  • "TicketCommitWithin48HoursCount": 26,
  • "TicketCommitWithin4HoursCount": 43,
  • "TicketCommitWithin7DaysCount": 46,
  • "TicketCount": 2526,
  • "TicketPriority": "TicketPriority Description",
  • "TicketPriorityID": 5678
}

Ticket Priority Journal Item Status Ticket Class Overview

An overview of each ticket priority, journal item status, and ticket class, along with counts of total, active, and time-related properties. [Rev 1.06]

  • Note: The elements which count tickets based on their commit date are cumulative (e.g. TicketCommitWithin4HoursCount includes the tickets included in TicketCommitWithin1HourCount as well as any ticket whose commit date is between one and four hours in the future).
Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "JournalItemStatus": "JournalItemStatus Description",
  • "JournalItemStatusID": 457,
  • "TicketActiveCount": 457,
  • "TicketClass": "TicketClass Description",
  • "TicketClassID": 3,
  • "TicketCommitOverdueCount": 568,
  • "TicketCommitWithin1HourCount": 68,
  • "TicketCommitWithin24HoursCount": 457,
  • "TicketCommitWithin48HoursCount": 475,
  • "TicketCommitWithin4HoursCount": 456,
  • "TicketCommitWithin7DaysCount": 684,
  • "TicketCount": 457,
  • "TicketPriority": "TicketPriority Description",
  • "TicketPriorityID": 457
}

Ticket Resolution Type

List of all ticket resolution types defined in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "EndDate": "2008-10-27T20:03:36.443Z",
  • "Name": "TicketResolutionType Name",
  • "StartDate": "2008-10-27T20:03:36.443Z",
  • "TicketResolutionTypeID": 568
}

Ticket State

A list of all the ticket states. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Name": "TicketState Name",
  • "TicketStateID": 346
}

Ticket Type Ticket Class Summary

A summary of total and active (if applicable) tickets for each ticket type and ticket class. [Rev 1.06]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "TicketActiveCount": 44,
  • "TicketClass": "My TicketClass Description",
  • "TicketClassID": 4,
  • "TicketCount": 357,
  • "TicketType": "My TicketType Description",
  • "TicketTypeID": 357
}

Ticket Urgency

List of all ticket urgencies configured in the system. [Rev 1.02]

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=Name eq 'Value'
  • A structured search expression in standard OData syntax.
$inlineCount
string
Enum: "allpages" "none"
Example: $inlineCount=allpages
  • Tells the server to include the total count of matching entities in the response.
$orderby
string
Example: $orderby=Name
  • A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select
string
Example: $select=Name
  • A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip
number
Example: $skip=10
  • Number of search results to skip.
$skiptoken
number
Example: $skiptoken=2
  • Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top
number
Example: $top=1
  • Number of search results to retrieve. If you specify a value greater than 100 and there are more than 100 results, only the first 100 results will be returned.

Responses

Response samples

Content type
application/json
{
  • "Name": "Ticket Urgency Name",
  • "TicketUrgencyID": 246
}

Release Notes

Latest WSDL

Release Notes 2.10

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • WSDL
  • Updated ObjectType to return 'Service' instead of 'Other' for JournalItems with an ObjectType of 'Service'.

Release Notes 2.01

  • WSDL
  • Updated ObjectType to return 'Service' instead of 'Other' for JournalItems with an ObjectType of 'Service'.

Release Notes 2.00

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.26

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.25

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.24

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.23

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.22

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.21

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.20

  • WSDL
  • Corrected oData query string parameters to use $inlineCount instead of $count

Release Notes 1.19

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.18

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.17

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.16

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.15

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.14

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.13

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.12

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.10

  • WSDL
  • Updated ObjectType validation - a trouble ticket cannot be associated with a Dispute for CreateJournalItemBase.
  • Updated ObjectType to return 'Dispute' instead of 'Other' for JournalItems on a dispute for JournalItem.
  • Updated ObjectType validation - a trouble ticket cannot be associated with a Dispute or JournalItem.
  • Added Dispute for ObjectType

Release Notes 1.09

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.08

  • WSDL
  • Added CorporateAccountTicketJournalItem to Core Data Service

Release Notes 1.07

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

  • WSDL
  • Added TicketClass, TicketPriorityAssignedUserTicketClassOverview, TicketPriorityJournalItemStatusTicketClassOverview, TicketTypeTicketClassSummary to Core Data Service
  • Added ObjectWorkflowInstanceLinks to CreateJournalItemBase
  • Added EmailAddress, EquipmentID To CreateTicket
  • Added ObjectWorkflowInstanceLinks to JournalItem
  • Added StatusSet as a possible value to ActionID to JournalItemHistory
  • Added EmailAlias, EmailLocalAddress to JournalItemType
  • Added Equipment to ObjectType
  • Added ObjectWorkflowInstanceLink to Object types
  • Added EmailAddress, EquipmentID to Ticket
  • Added Email to TicketClass
  • Added EmailAddress, Equipment, EquipmentID, EquipmentType, EquipmentTypeID to TicketJournal Item
  • Added Email to TicketClassID
  • Added EmailAddress, Email, TicketClassID, Equipment, EquipmentID, EquipmentType, EquipmentTypeID, ObjectDescription to TIcketJournalitemSummary
  • Added AccountNumber, CustomerID, CustomerName to TicketLocation

Release Notes 1.05

  • WSDL
  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

  • WSDL
  • Deprecated AuthenticatedKey for CreateJournalItemBase and JournalItem

Release Notes 1.03

  • WSDL
  • Added WorkflowEnvironment, WorkItemInstanceID to CreateFollowUp, CreateJournal, CreateTicket, FollowUp, Journal, JournalItem (OData), Ticket, TicketJournalItem, TicketJournalItemSummary
  • Added 500508 to ModifyJournalItem

Release Notes 1.02

  • WSDL
  • Added AvailableTicketLocation, JournalItemChildJournalItemTypeOverview, JournalItemHistory, JournalItemTypeSummary, TicketCategory, TicketCategoryConfiguration, TicketHoldReason, TicketImpact, TicketJournalItem, TicketJournalItemSummary, TicketPriority, TicketPriorityAssignedUserOverview, TicketPriorityConfiguration, TicketPriorityJournalItemStatusOverview, TicketResolutionType, TicketState, TicketUrgency, TicketLocation to Core Data Service.
  • Added TicketClass to Enums and Constants
  • Added ActionDateWithOffset, CloseDateWithOffset, CommitDateWithOffset to JournalItem
  • Added TicketState, TicketStateID to JournalItemStatus
  • Added EndDateWithOffset, StartDateWithOffset to JournalItemType
  • Added CreateTicket, Ticket, TicketLocation to Object Types

Release Notes 1.01

  • WSDL
  • Added ExtendedInformationItem to Core Data Service and MessageItemType
  • Added Remove to ModifyJournalItemReq
  • Added RemoveSuccessful to ModifyJournalItemResult
  • Added ExtendedInformationItem, ModifyExtendedInformationReq, ModifyExtendedInformationResult to Object Types
  • Added ModifyExtendedInformation to Operations and Setup